Micron Document

NomadNet
──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────────
NomadNet (Nomad Network) is a terminal-based LXMF and RRC client by Mark Qvist that provides encrypted peer-to-peer messaging, chat, file sharing and hypertext. It has a built-in text-based browser and page server with support for dynamically rendered pages, user authentication and more.cite-ref-1[1]

Contents
Installing

See How do I get started? ↗ in the README. Basically pip install nomadnet.

Configuration

The configuration directory for NomadNet is ~/.nomadnetwork unless an alternative path is given with --config=<config directory>. On first run, a configuration file will be created (~/.nomadnetwork/config by default).

Usage

NomadNet may be used as a terminal client, a page and file server, and a basic propagation node for LXMF messages.

By default, nomadnet runs as a client. To run in daemon mode, use nomadnet --daemon.

Because NomadNet depends on LXMF and RNS, it is possible to run only nomadnet --daemon to combine the functionality of all three instead of running each separately. See RNS › Shared instance.

Other clients

The following apps also support browsing NomadNet nodes:

• rBrowser

Nodes

A NomadNet node is an instance of NomadNet that is visible to other peers on the network, serving pages and files.

Nodes appear in the Network screen's Announce Stream pane as their announces come in, and can be saved in Saved Nodes with Ctrl+S. Ctrl+L toggles between the Announce Stream and Saved Nodes. You can also enter a node's address directly with Ctrl+U.

Some useful nodes

Aleph Git: a8d24177d946de4f1f0a0fe1af9a1338 – Mark Qvist's rngit node, hosting official and mirroring related repositories.
• RNS.recipes Forum: 9ce92808be498e9e05590ff27cbfdfe4 – NomadNet interface of the community forum.
• Amber Pages: 8df9fffe5548121d15664a86dbfcca32 – Most recently seen nodes on the ret.
• Amber Hubs: 085b5d6ade4a19687ff9f62e8d6f257e – Most recently seen RRC hubs on the ret.
• Reticulum Community Wiki: 72a2d9c12215802605779f4366d48335 – This wiki.

Becoming a node

To become a node, set enable_node = true and specify a node_name in the NomadNet configuration file. Pages will be served from storage/pages of the configuration directory (~/.nomadnetwork/storage/pages by default) and must be in the micron format, a lightweight markup language optimized for Reticulum. Index pages must have the filename index.mu.

To not participate as a propagation node, you can set disable_propagation = true.

References

cite-note-11. Nomad Network, Manual. a8d24177d946de4f1f0a0fe1af9a1338:/page/blob.mu

External links

• Official website
• PyPI project

NomadNet

Type: LXMF and RRC client
Developer: Mark Qvist
License: GPL-3.0
Written in: Python
Platform: Linux, macOS, Windows, openBSD
Since: 2021-03-27
Website: unsigned.io
Repository: Aleph Git ↗